Skip to main content

Webhook: TASK_STARTS_SOON

The TASK_STARTS_SOON webhook is triggered 15 minutes before a task is scheduled to start. It notifies subscribers to ensure preparedness or to notify assigned users about upcoming tasks.

Purpose​

This webhook is designed to:

  • Inform systems or users in advance about a task.
  • Improve task management and readiness.
  • Provide automation opportunities by offering real-time notifications.

Request Format​

The webhook is sent as an HTTP POST request with the following payload:

{
   "entityId": "0b4c861b-36bc-489f-bdeb-ef7b4135d413",
   "type": "TASK_STARTS_SOON",
   "createdAt": "2024-12-13T09:45:21.300Z",
   "data": {
      "id": "0b4c861b-36bc-489f-bdeb-ef7b4135d413",
      "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
      "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
      "seriesId": null,
      "recurrenceRule": null,
      "recurrenceException": null,
      "startAt": "2024-12-13T10:00:00.000Z",
      "endAt": "2024-12-13T11:00:00.000Z",
      "name": "Task 1",
      "priority": "MAJOR",
      "orderStepsRequired": false,
      "strictTimeRequired": false,
      "deadlined": false,
      "published": true,
      "tags": [],
      "assigneeIds": [
         "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      ],
      "externalId": null,
      "createdBy": "6ad1a95b-ea50-4e23-8495-ef82900ca98d",
      "createdAt": "2024-12-13T09:40:24.224Z",
      "lastModifiedBy": "6ad1a95b-ea50-4e23-8495-ef82900ca98d",
      "lastModifiedAt": "2024-12-13T09:40:24.224Z",
      "stepId": null,
      "actionId": null
   }
}

Key Properties​

Top-Level Properties​

  • entityId: Unique identifier for the task.
  • type: Indicates the type of webhook (e.g., TASK_STARTS_SOON).
  • createdAt: The timestamp when the webhook was triggered (in ISO 8601 format).

Data Section​

Contains detailed information about the task:

  • id: Unique task identifier.
  • organizationId: ID of the organization associated with the task.
  • locationId: ID of the task's location.
  • startAt: Task start time in ISO 8601 format.
  • endAt: Task end time in ISO 8601 format.
  • priority: Priority level of the task (e.g., MAJOR).
  • assigneeIds: List of user IDs assigned to the task.
  • createdBy: ID of the user who created the task.
  • lastModifiedBy: ID of the user who last modified the task.

Response Example​

A successful response mirrors the request payload and confirms receipt:

{
   "entityId": "0b4c861b-36bc-489f-bdeb-ef7b4135d413",
   "type": "TASK_STARTS_SOON",
   "createdAt": "2024-12-13T09:45:21.300Z",
   "data": {
      "id": "0b4c861b-36bc-489f-bdeb-ef7b4135d413",
      "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
      "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
      "seriesId": null,
      "recurrenceRule": null,
      "recurrenceException": null,
      "startAt": "2024-12-13T10:00:00.000Z",
      "endAt": "2024-12-13T11:00:00.000Z",
      "name": "Task 1",
      "priority": "MAJOR",
      "orderStepsRequired": false,
      "strictTimeRequired": false,
      "deadlined": false,
      "published": true,
      "tags": [],
      "assigneeIds": [
         "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      ],
      "externalId": null,
      "createdBy": "6ad1a95b-ea50-4e23-8495-ef82900ca98d",
      "createdAt": "2024-12-13T09:40:24.224Z",
      "lastModifiedBy": "6ad1a95b-ea50-4e23-8495-ef82900ca98d",
      "lastModifiedAt": "2024-12-13T09:40:24.224Z",
      "stepId": null,
      "actionId": null
   }
}

Benefits of TASK_STARTS_SOON​

  • Ensures timely preparation for upcoming tasks.
  • Supports efficient scheduling and resource management.
  • Enhances task tracking and readiness across teams or systems.